Создание нового района

Запрос позволяет создать новый район поездок клиента.

Синтаксис запроса

POST https://b2b-api.go.yandex.ru/integration/2.0/geo_restrictions/create
Устаревший метод
POST https://b2b-api.go.yandex.ru/integration/2.0/geo_restrictions

Заголовки запроса

  • Authorization: Bearer <OAuth-токен>
    Процесс получения токена описан в разделе Начало работы.
  • X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Тело запроса

Данные о новом районе передаются в теле запроса в формате JSON:

Поле Описание Формат Обязательность
name Имя. Строка Да
geo_type Тип гео ограничения. Сейчас поддерживается только circle. Строка Да
geo Описание гео ограничения. Содержит следующие поля:
- center — координаты центра;
- radius — расстояние от центра (в метрах).		 Объект Да

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
id Идентификационный номер района поездок. Строка

Пример запроса

POST https://b2b-api.go.yandex.ru/integration/2.0/geo_restrictions/create
  {
    "geo": {
      "center": [
        37.642639,
        55.734894
      ],
      "radius": 200
    },
    "geo_type": "circle",
    "name": "Офис 2"
  }

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

  {
      "id": "b45efcaa04014fff997c2683ef91f0de"
  }

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением. Например, запись с указанными данными уже существует.
  • 401 — был передан неверный OAuth-токен.
  • 403 — у клиента не хватает прав на выполнение данного запроса.
    • SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
    • SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
Предыдущая
Список районов
Следующая
Изменение района